docs: GtkWidget::style-updated vs GtkStyleContext::changed
authorSébastien Wilmet <swilmet@gnome.org>
Sun, 24 Jul 2016 15:20:29 +0000 (17:20 +0200)
committerMatthias Clasen <mclasen@redhat.com>
Mon, 25 Jul 2016 13:26:41 +0000 (09:26 -0400)
Explain the difference between those two signals.

Add "Since: 3.0" for GtkStyleContext::changed, since that signal has
been added in commit 9f84e101bf150a85f82e15c56130b1f98b8fdbf0, present
since 2.91.6.

https://bugzilla.gnome.org/show_bug.cgi?id=769047

gtk/gtkstylecontext.c
gtk/gtkwidget.c

index a6191bd0d11fc2b79d64493fb4d4a47a8c784785..03a16aac49df597166699c6b4f9bea4b9d79f019 100644 (file)
@@ -201,6 +201,19 @@ gtk_style_context_class_init (GtkStyleContextClass *klass)
 
   klass->changed = gtk_style_context_real_changed;
 
+  /**
+   * GtkStyleContext::changed:
+   *
+   * The ::changed signal is emitted when there is a change in the
+   * #GtkStyleContext.
+   *
+   * For a #GtkStyleContext returned by gtk_widget_get_style_context(), the
+   * #GtkWidget::style-updated signal/vfunc might be more convenient to use.
+   *
+   * This signal is useful when using the theming layer standalone.
+   *
+   * Since: 3.0
+   */
   signals[CHANGED] =
     g_signal_new (I_("changed"),
                   G_TYPE_FROM_CLASS (object_class),
index 52a999574141d6daaace716704847c04589d89fa..cf9e4c69fcab83a487f81806a770a6d52eace2a9 100644 (file)
@@ -1903,9 +1903,12 @@ G_GNUC_END_IGNORE_DEPRECATIONS
    * GtkWidget::style-updated:
    * @widget: the object on which the signal is emitted
    *
-   * The ::style-updated signal is emitted when the #GtkStyleContext
-   * of a widget is changed. Note that style-modifying functions like
-   * gtk_widget_override_color() also cause this signal to be emitted.
+   * The ::style-updated signal is a convenience signal that is emitted when the
+   * #GtkStyleContext::changed signal is emitted on the @widget's associated
+   * #GtkStyleContext as returned by gtk_widget_get_style_context().
+   *
+   * Note that style-modifying functions like gtk_widget_override_color() also
+   * cause this signal to be emitted.
    *
    * Since: 3.0
    */